Update docs for deps and conda #408
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
docs/installation.md
Outdated
| ``` | ||
|
|
||
| This will install the programs ``vcf2zarr`` and ``vcf_partition`` | ||
| into your local Python path. You may need to update your $PATH to call the | ||
| For bioconda users, the package is available in the |
There was a problem hiding this comment.
Should clarify that this includes all dependencies bundled in, i.e., equivalent to running pip install bio2zarr[all]
docs/installation.md
Outdated
| conda install -c bioconda bio2zarr | ||
| ``` | ||
|
|
||
| This will install the programs ``vcf2zarr``, ``vcf_partition``, ``tskit2zarr` |
There was a problem hiding this comment.
Suggested change
| This will install the programs ``vcf2zarr``, ``vcf_partition``, ``tskit2zarr` | |
| This will install the programs ``vcf2zarr``, ``vcf_partition``, ``tskit2zarr`` |
docs/installation.md
Outdated
Comment on lines
38
to
39
| Windows is not currently directly supported. We recommend the use | ||
| of Windows Subsystem for Linux (WSL) Please comment on |
There was a problem hiding this comment.
Suggested change
| Windows is not currently directly supported. We recommend the use | |
| of Windows Subsystem for Linux (WSL) Please comment on | |
| Windows support is preliminary, partial and needs to be fully documented. We recommend trying the bioconda packages in the first instance, and if this doesn't work try using | |
| Windows Subsystem for Linux (WSL). Please comment on |
docs/installation.md
Outdated
| [this issue](https://github.com/sgkit-dev/bio2zarr/issues/174) if you would | ||
| like to see Windows support for bio2zarr. | ||
| like to see direct Windows support for bio2zarr. |
There was a problem hiding this comment.
Suggested change
| like to see direct Windows support for bio2zarr. | |
| if you would like to see improved Windows support for bio2zarr, or would like to help out with this. |
|
Fixed up |
jeromekelleher
approved these changes
May 23, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #203
Closes #396
Closes #388
Requires #401 for the plink2zarr comments to make sense.